home *** CD-ROM | disk | FTP | other *** search
/ Whiteline: delta / whiteline CD Series - delta.iso / document / hypertxt / refchk17 / refcheck.man < prev    next >
Text File  |  1995-11-25  |  11KB  |  221 lines

  1. NAME
  2.     refcheck - Überprüft die Konsistenz der ALL.REF ($REF) des ST-Guide
  3.  
  4. SYNOPSIS
  5.     refcheck [-adghiks]
  6.  
  7. BESCHREIBUNG
  8.     Zuerst liest REFCHECK aus der Datei ST-GUIDE.INF die Variablen PATHS und
  9.     REF. Sollte außerdem die Variable REFPATHS existieren, wird diese 
  10.     anstelle von PATHS benutzt. So kann man bestimmen, daß nur die 
  11.     REF-Dateien von Hypertexten aus bestimmten Pfaden in die ALL.REF 
  12.     aufgenommen werden.
  13.     
  14.     Die in der Variablen REF stehende REF-Datei, ist die von REFLINK 
  15.     erzeugte 'REF-Bibliothek' (z.B. ALL.REF). Diese wird geladen und auf 
  16.     ihre Korrektheit und Aktualität überprüft.
  17.  
  18.     Dazu werden alle HYP-Dateien, die sich in den hinter [REF]PATHS 
  19.     angegebenen Pfaden befinden, gesucht, mit der ALL.REF verglichen und in 
  20.     der ALL.REF überflüssige Module (zu denen keine HYP-Datei existiert) 
  21.     angezeigt. Evtl. vorhandene (und zu den HYPs passende) REF-Dateien 
  22.     werden auf Aktualität und Existenz in der ALL.REF überprüft. Auf Wunsch
  23.     wird die ALL.REF durch Aufruf von REFLINK mit der entsprechenden 
  24.     Kommandozeile automatisch aktualisiert.
  25.  
  26.     Ist die Option -s nicht gesetzt werden alle gefundenen HYP-Dateien und
  27.     Modulnamen zusammen mit Offset und Länge des Moduls auf dem Bildschirm
  28.     ausgegeben. Erscheint hinter einem Modulnamen ein Ausrufezeichen (!),
  29.     bedeutet das, daß der Dateiname nicht mit dem Modulnamen übereinstimmt,
  30.     was aber nur selten vorkommt. Bei solchen Hypertexten sollte man die
  31.     REF-Datei nicht löschen, weil REF-Check sonst beim nächsten Lauf das
  32.     Modul in der ALL.REF nicht zu einem Hypertext zuordnen kann und evtl.
  33.     wieder löschen läßt! Die Option -k wird in solchen Fällen automatisch
  34.     deaktiviert (REFLINK wird also für dieses eine File nicht mit -m,
  35.     sondern mit -a aufgerufen)!
  36.  
  37.     Um die Bildschirm-Ausgaben von REFCHECK in eine Datei zu schreiben,
  38.     benutzen Sie eine Kommando-Shell mit Ausgabeumlenkung (z.B. Mupfel)!
  39.  
  40.     Bei Fragen über den Sinn und Zweck von REF-Dateien, ST-GUIDE.INF,
  41.     REFLINK usw. lesen Sie bitte die Anleitungen zum ST-Guide-System!
  42.  
  43. OPTIONEN
  44.     -a  (add)
  45.         Neue bzw. aktuellere REF-Dateien in $[REF]PATHS automatisch in $REF
  46.         aufnehmen bzw. aktualisieren.
  47.  
  48.     -d  (delete)
  49.         Bei in $[REF]PATHS nicht mehr vorhandenen HYP-Dateien automatisch 
  50.         die dazu gehörenden Module aus $REF löschen.
  51.  
  52.     -g  (global)
  53.         Alle in $[REF]PATHS gefundenen REF-Dateien in $REF aufnehmen bzw.
  54.         aktualisieren, egal ob schon vorhanden und/oder gleiche Modullänge.
  55.  
  56.     -h  (hold)
  57.         Am Ende auf Tastendruck warten.
  58.  
  59.     -i  (interactive)
  60.         Bei a/d/g einzeln nachfragen. Dabei wird jeweils die Kommandozeile
  61.         für REFLINK angezeigt und gefragt, ob REFLINK gestartet werden soll.
  62.         Man kann wählen zwischen:
  63.         J: REFLINK starten (auch Return, deshalb ein großes "J").
  64.         n: REFLINK nicht starten.
  65.         a: Wie "J" und alle weiteren REFLINK-Aufrufe ohne Nachfrage.
  66.            Alle weiteren REFLINK-Aufrufe mit der Option -d (löschen) werden
  67.            anschließend in einem einzigen Aufruf zusammengefaßt!
  68.         q: Wie "n" und keine weiteren REFLINK-Aufrufe mehr.
  69.  
  70.     -k (kill)
  71.        Bei a/g wird REFLINK mit der Option -m (move) gestartet, so daß die
  72.        bearbeiteten REF-Dateien anschließend automatisch gelöscht werden.
  73.  
  74.     -s (silent)
  75.        Die Bildschirmausgaben werden auf das nötigste beschränkt, wodurch
  76.        eine höhere Geschwindigkeit erzielt wird.
  77.  
  78.     ([REF]PATHS und REF aus ST-GUIDE.INF!)
  79.  
  80.     Bei unbekannten Optionen (z.B. -?) wird eine Hilfe ausgegeben!
  81.  
  82.     Alle Optionen können auch über die Variable REFCHECK-OPT in der Datei
  83.     ST-GUIDE.INF gesetzt werden. Diese Variable wird aber nur ausgewertet,
  84.     wenn die Kommandozeile von REFCHECK leer ist!
  85.  
  86.     Beispiel: REFCHECK-OPT=ads
  87.  
  88.     Wer REFCHECK oft oder nur vom Desktop startet und nur noch die Variable
  89.     REFCHECK-OPT nutzt, kann REFCHECK.TTP natürlich in REFCHECK.TOS
  90.     umbenennen, dann entfällt die überflüssige TTP-Parameterabfrage!
  91.  
  92. BEISPIELE
  93.     refcheck
  94.         Die Ergebnisse werden nur am Bildschirm angezeigt (evtl. -h setzen).
  95.         Es finden keine Schreibzugriffe statt. Hiermit kann man sich also
  96.         erstmal einen Überblick verschaffen.
  97.  
  98.     refcheck -ad
  99.         Die ALL.REF wird automatisch und ohne Nachfragen auf den neuesten
  100.         Stand gebracht.
  101.  
  102.     refcheck -dg
  103.         refcheck erkennt geänderte Module mit der Option -a nur daran, daß
  104.         sich die Modullänge geändert hat. Will man ganz sicher gehen, kann
  105.         man mit der Option -g ALLE REF-Dateien nochmal neu in die ALL.REF
  106.         schreiben lassen. Anschließend enthält diese auf jeden Fall alle
  107.         aktuellen REF-Dateien! Wenn man viele Hypertexte mit REF-Dateien
  108.         hat, kann das natürlich etwas länger dauern!
  109.  
  110. DATEIEN
  111.     ST-GUIDE.INF
  112.         Muß sich im HOME-Directory oder im Wurzelverzeichnis des
  113.         Bootlaufwerkes befinden.
  114.  
  115.     REFLINK.TTP
  116.         Wird evtl. von REFCHECK gestartet. Dazu muß in der Datei 
  117.         ST-GUIDE.INF zwingend die Variable REFLINK (Pfad und Name von 
  118.         REFLINK) definiert sein! Anderenfalls werden die Optionen -[adg] 
  119.         ignoriert und beim Programmstart erscheint eine Warnung!
  120.  
  121.         Beispiel: REFLINK=h:\hyp\bin\reflink.ttp
  122.  
  123. ENVIRONMENT
  124.     HOME
  125.         Wird bei der Suche nach der ST-GUIDE.INF ausgewertet.
  126.  
  127. VERSIONEN
  128.     1.0 - Erstveröffentlichung.
  129.     1.1 - Compiliert mit hcc 2.00x23 und gelinkt mit den neuen XDLibs aus
  130.           dem Sozobon-Release 07.
  131.         - Sollte jetzt auch mit Alias-Programmen unter Gemini zurechtkommen
  132.           (reflink.ttp), da zuerst versucht wird, das Programm mit system()
  133.           zu starten.
  134.         - Bugfix: Ein lokales Array war zu groß für den Stack. Eigentlich
  135.           hätte das Programm abstürzen müssen. Warum es trotzdem lief,
  136.           weiß ich auch nicht;-)
  137.         - In den Beipielen der man page stand "reflink" statt "refcheck".
  138.         - Man page jetzt auch als Hypertext REFCHECK.HYP.
  139.         - Modulnamen wurden evtl. nicht in voller Länge verglichen. Z.B.
  140.           wurde beim Modul "aip" irrtümlich auch "aip_auto" oder "aip_prog"
  141.           erkannt!
  142.         - Neues Konzept: Es wird nicht mehr nach REF-Dateien, sondern nach
  143.           HYP-Dateien und dann erst nach der passenden REF-Datei gesucht!
  144.           Dadurch funktioniert der Schalter -d jetzt auch, wenn man nur mit
  145.           der ALL.REF arbeitet und die Module werden nicht gelöscht. Nur,
  146.           wenn die HYP-Datei fehlt, wird ein Modul aus der ALL.REF gelöscht!
  147.         - Maximale Anzahl der HYP-Dateien auf 1024 erhöht (bisher 200). Ich
  148.           denke, das sollte fürs erste ausreichen!
  149.     1.2 - Neue Option -k. Hiermit werden die REF-Dateien nach erfolgreicher
  150.           Aktualisierung/Aufnahme von der Platte gelöscht! Besonders
  151.           geeignet für diejenigen, die nur mit der ALL.REF arbeiten!
  152.         - Optionsbeschreibung im Usage-Text an die man page angepaßt.
  153.         - Wenn die Environmentvariable HOME existiert, wird die ST-GUIDE.INF
  154.           zuerst dort gesucht.
  155.    1.21 - Starten von REFLINK funktionierte nicht richtig, wenn weder eine
  156.           Shell gefunden wurde, noch die System-Environmentvariable PATH
  157.           existierte oder einen gültigen Pfad für REFLINK enthielt. Im
  158.           aktuellen Verzeichnis wurde auch nicht gesucht. Jetzt wird, wenn
  159.           keie Shell existiert, zuerst im aktuellen Verzeichnis gesucht und
  160.           erst wenn das fehlschägt, wird REFLINK mit spawnlp() gestartet.
  161.     1.3 - Bei den Suchvorgängen werden jetzt alle gefundenen Module und
  162.           Dateien angezeigt. Beim Scannen der ALL.REF wird jeweils
  163.           Modulname, Offset und -länge, bei der HYP-Suche HYP-Name und falls
  164.           vorhanden "+REF", Modulname und -länge ausgegeben!
  165.         - Absturz beseitigt, wenn die ALL.REF ein Modul mit einer Länge
  166.           >32767 Bytes enthielt.
  167.         - REFCHECK berücksichtigt jetzt die Tatsache, daß auch einfache
  168.           REF-Dateien mehr als ein Modul enthalten können, z.B. ENG_GER.REF.
  169.         - Wenn die Option -k gesetzt ist, wird die REF-Datei jetzt nicht
  170.           mehr von REFCHECK gelöscht, sondern REFLINK mit der Option -m
  171.           (move) gestartet.
  172.         - Speicheranforderungen (malloc) werden jetzt überprüft.
  173.         - Fehlerhaftes spawn-Binding ersetzt. Dank an Jerry Geiger @ B,
  174.           der mir die korrigierte spawn3.o als UUE geschickt hat:-)
  175.         - REFLINK-Aufrufe mit der Option -d (löschen) werden jetzt in einem
  176.           einzigen Aufruf zusammengefaßt, wenn die REFCHECK-Option -i nicht
  177.           gesetzt ist oder bei einer Abfrage durch [a] deaktiviert wurde!
  178.         - Option -s (silent) beschränkt die Bildschirmausgaben auf das
  179.           nötigste -> schneller.
  180.         - Die Option -g (global) wurde nicht beachtet, wenn eine REF-Datei
  181.           noch nicht in der ALL.REF vorhanden war.
  182.     1.4 - Variablen REFLINK und REFCHECK-OPT in der Datei ST-GUIDE.INF
  183.           werden ausgewertet.
  184.     1.5 - HYP/REF-Dateien und Module in der ALL.REF werden jetzt auch dann
  185.           einander korrekt zugeordnet, wenn der Name der HYP-Datei nicht mit
  186.           dem Modulnamen in der REF-Datei übereinstimmt. Aktuelles Beispiel:
  187.           Dateiname: POV.HYP/REF, Modulname: POV_DEUT (deutsche Version)!
  188.         - Wenn der Dateiname nicht mit dem Modulnamen übereinstimmt,
  189.           erscheint in der Ausgabeliste (wenn Option -s nicht gesetzt) ein
  190.           Ausrufezeichen (!) hinter dem Modulnamen. Außerdem wird eine
  191.           gesetzte move-Option (-k) für diese REF-Datei deaktiviert, damit
  192.           die Datei erhalten bleibt und REFCHECK beim nächsten Aufruf den
  193.           Modulnamen korrekt zuordnen kann (sonst würde das Modul evtl.
  194.           gleich wieder aus der ALL.REF gelöscht)!
  195.     1.6 - Zum Starten von REFLINK muß jetzt zwingend die Variable
  196.           REFLINK in der ST-GUIDE.INF definiert sein. Der Start über
  197.           eine System-Shell wird nicht mehr unterstützt!
  198.         - Wenn in der ST-GUIDE.INF die Variable REFPATHS gefunden wird, wird
  199.           diese anstelle von PATHS benutzt. So kann man bestimmen, daß nur
  200.           die REF-Dateien von Hypertexten aus bestimmten Pfaden in die
  201.           ALL.REF aufgenommen werden.
  202.         - Die mögliche Anzahl der HYP-Dateien/Module ist nur noch durch
  203.           den freien Speicherplatz beschränkt.
  204.     1.7 - Bugfix: REFCHECK stürzte ab, wenn keine ALL.REF existierte.
  205.  
  206. COPYRIGHT
  207.     REFCHECK ist Freeware, d.h. das Programm darf beliebig  weitergegeben
  208.     werden, allerdings nur unverändert und komplett mit allen Dateien.
  209.  
  210. DISCLAIMER
  211.     Ich übernehme keine Haftung für Schäden jeglicher Art, die durch die
  212.     Benutzung oder Nicht-Benutzung von REFCHECK entstanden sind.
  213.  
  214. AUTOR
  215.     Frank Rüger
  216.     Tecklenburger Straße 21
  217.     D-49525 Lengerich
  218.  
  219.     email: Frank Rüger @ OS2 im Mausnetz bzw.
  220.            Frank_Rueger@os2.maus.de aus dem InterNet
  221.